Foxit PDF SDK
FoxitPDFSDKPython3.PDFArray类 参考
类 FoxitPDFSDKPython3.PDFArray 继承关系图:
FoxitPDFSDKPython3.PDFObject

Public 成员函数

def AddBoolean (boolean_value)
 将布尔值添加到当前PDF数组对象的末尾。 更多...
 
def AddDateTime (date_time)
 将日期时间添加到当前PDF数组对象的末尾。 更多...
 
def AddElement (element)
 将PDF对象添加到当前PDF数组对象的末尾。 更多...
 
def AddFloat (float_value)
 将浮点数值添加到当前PDF数组对象的末尾。 更多...
 
def AddInteger (integer_value)
 将整数值添加到当前PDF数组对象的末尾。 更多...
 
def AddMatrix (matrix)
 将矩阵添加到当前PDF数组对象的末尾。 更多...
 
def AddName (name)
 将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
 
def AddRect (rect)
 将矩形添加到当前PDF数组对象的末尾。 更多...
 
def AddReference (pdf_object, document)
 将间接PDF对象(其对象编号总是大于0)的引用对象设置为值元素。 更多...
 
def AddString (new_string)
 将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
 
def GetElement (index)
 通过索引获取指定的元素。 更多...
 
def GetElementCount ()
 获取元素的数量。 更多...
 
def InsertAt (index, element)
 将PDF对象插入到当前PDF数组对象的指定位置。 更多...
 
def RemoveAt (index)
 从当前PDF数组对象中移除指定位置(按索引)的元素。 更多...
 
def SetAt (index, element)
 在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
 
- Public 成员函数 继承自 FoxitPDFSDKPython3.PDFObject
def CloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
def DeepCloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
def GetArray ()
 获取当前PDF对象的PDF数组对象。 更多...
 
def GetBoolean ()
 获取当前PDF对象的布尔值。 更多...
 
def GetDateTime ()
 获取当前PDF对象的日期时间值。 更多...
 
def GetDict ()
 获取当前PDF对象的PDF字典对象。 更多...
 
def GetDirectObject ()
 获取当前PDF对象的直接对象。 更多...
 
def GetFloat ()
 获取当前PDF对象的浮点数值。 更多...
 
def GetInteger ()
 获取当前PDF对象的整数值。 更多...
 
def GetMatrix ()
 获取当前PDF对象的矩阵值。 更多...
 
def GetName ()
 获取当前PDF对象的名称值。 更多...
 
def GetObjNum ()
 获取当前PDF对象的间接对象编号。 更多...
 
def GetRect ()
 获取当前PDF对象的矩形值。 更多...
 
def GetStream ()
 获取当前PDF对象的PDF流对象。 更多...
 
def GetString ()
 获取当前PDF对象的字符串值。 更多...
 
def GetType ()
 获取当前PDF对象的类型。 更多...
 
def GetWideString ()
 获取当前PDF对象的宽字符串值。 更多...
 
def IsIdentical (pdf_obj)
 检查输入的PDF对象是否与当前PDF对象相同。 更多...
 
def Release ()
 释放新创建的PDF对象或克隆PDF对象, 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...
 

静态 Public 成员函数

def Create ()
 创建新的数组对象。 更多...
 
def CreateFromMatrix (matrix)
 为矩阵创建新的数组对象。 更多...
 
def CreateFromRect (rect)
 为矩形创建新的数组对象。 更多...
 
- 静态 Public 成员函数 继承自 FoxitPDFSDKPython3.PDFObject
def CreateFromBoolean (boolean_value)
 从布尔值创建PDF对象。 更多...
 
def CreateFromDateTime (date_time)
 从日期时间创建PDF对象。 更多...
 
def CreateFromFloat (float_value)
 从浮点数创建PDF对象。 更多...
 
def CreateFromInteger (integer_value)
 Create a PDF object from a integer number. 更多...
 
def CreateFromName (name)
 从表示名称的字符串创建PDF对象。 更多...
 
def CreateFromNameW (name)
 从表示名称的字符串创建PDF对象。 更多...
 
def CreateFromString (string_value)
 从字符串创建PDF对象。 更多...
 
def CreateFromString (string_value, length)
 从字符串创建PDF对象。 更多...
 
def CreateReference (document, object_number)
 为间接对象创建引用。 更多...
 

额外继承的成员函数

- 静态 Public 属性 继承自 FoxitPDFSDKPython3.PDFObject
 e_Array = _fsdk.PDFObject_e_Array
 PDF数组对象。
 
 e_Boolean = _fsdk.PDFObject_e_Boolean
 PDF布尔对象。
 
 e_Dictionary = _fsdk.PDFObject_e_Dictionary
 PDF字典对象。
 
 e_InvalidType = _fsdk.PDFObject_e_InvalidType
 无效的PDF对象类型。
 
 e_Name = _fsdk.PDFObject_e_Name
 PDF名称对象。
 
 e_Null = _fsdk.PDFObject_e_Null
 PDF空对象。
 
 e_Number = _fsdk.PDFObject_e_Number
 PDF数字对象。
 
 e_Reference = _fsdk.PDFObject_e_Reference
 PDF引用对象。
 
 e_Stream = _fsdk.PDFObject_e_Stream
 PDF流对象。
 
 e_String = _fsdk.PDFObject_e_String
 PDF字符串对象。
 

详细描述

PDF数组对象是按顺序排列的对象的一维集合。 与许多其他计算机语言中的数组不同,PDF数组中的元素可以是数字、 字符串、字典或任何其他对象(包括其他数组)的任意组合。 有关更多详细信息,请参阅<PDF Reference 1.7>中的第3.2.5节“数组对象”。
FoxitPDFSDKPython3.PDFArray 派生自PDFObject ,并提供函数来创建新的PDF数组对象以及 获取/设置PDF数组对象的元素。

参见
PDFObject

成员函数说明

◆ AddBoolean()

def FoxitPDFSDKPython3.PDFArray.AddBoolean (   boolean_value)

将布尔值添加到当前PDF数组对象的末尾。

参数
[in]boolean_value要添加到当前PDF数组对象的布尔值。
返回
无。

◆ AddDateTime()

def FoxitPDFSDKPython3.PDFArray.AddDateTime (   date_time)

将日期时间添加到当前PDF数组对象的末尾。

参数
[in]date_time要添加到当前PDF数组对象的日期时间。
返回
无。

◆ AddElement()

def FoxitPDFSDKPython3.PDFArray.AddElement (   element)

将PDF对象添加到当前PDF数组对象的末尾。

参数
[in]element要添加到当前PDF数组对象的PDF对象。它不应为null
返回
无。

◆ AddFloat()

def FoxitPDFSDKPython3.PDFArray.AddFloat (   float_value)

将浮点数值添加到当前PDF数组对象的末尾。

参数
[in]float_value要添加到当前PDF数组对象的浮点数值。
返回
无。

◆ AddInteger()

def FoxitPDFSDKPython3.PDFArray.AddInteger (   integer_value)

将整数值添加到当前PDF数组对象的末尾。

参数
[in]integer_value要添加到当前PDF数组对象的整数值。
返回
无。

◆ AddMatrix()

def FoxitPDFSDKPython3.PDFArray.AddMatrix (   matrix)

将矩阵添加到当前PDF数组对象的末尾。

参数
[in]matrix要添加到当前PDF数组对象的矩阵。
返回
无。

◆ AddName()

def FoxitPDFSDKPython3.PDFArray.AddName (   name)

将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。

参数
[in]name要作为PDF名称对象添加到当前PDF数组对象的字符串。 它不应为空字符串。
返回
无。

◆ AddRect()

def FoxitPDFSDKPython3.PDFArray.AddRect (   rect)

将矩形添加到当前PDF数组对象的末尾。

参数
[in]rect要添加到当前PDF数组对象的矩形。
返回
无。

◆ AddReference()

def FoxitPDFSDKPython3.PDFArray.AddReference (   pdf_object,
  document 
)

将间接PDF对象(其对象编号总是大于0)的引用对象设置为值元素。

如果用户想要将直接PDF对象(其对象编号总是等于0)设置到条目, 请参考函数FoxitPDFSDKPython3.PDFDictionary.SetAt

参数
[in]pdf_object一个PDFObject 对象,它是一个间接PDF对象(其对象编号总是大于0), 将通过引用此间接对象的引用对象设置到条目。它不应为null
[in]document一个有效的PDF文档对象,当前PDF字典对象属于该文档, 且参数pdf_object是或将是其中的间接对象。
返回
无。

◆ AddString()

def FoxitPDFSDKPython3.PDFArray.AddString (   new_string)

将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。

参数
[in]new_string要作为PDF字符串对象添加到当前PDF数组对象的字符串。 它不应为空字符串。
返回
无。

◆ Create()

FoxitPDFSDKPython3.PDFArray.Create ( )
static

创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

返回
一个新的PDFArray 对象。 如果有任何错误,此函数将返回null

◆ CreateFromMatrix()

FoxitPDFSDKPython3.PDFArray.CreateFromMatrix (   matrix)
static

为矩阵创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数
[in]matrix一个矩阵。
返回
一个新的PDFArray 对象。 如果有任何错误,此函数将返回null

◆ CreateFromRect()

FoxitPDFSDKPython3.PDFArray.CreateFromRect (   rect)
static

为矩形创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数
[in]rect一个矩形。
返回
一个新的PDFArray 对象。 如果有任何错误,此函数将返回null

◆ GetElement()

def FoxitPDFSDKPython3.PDFArray.GetElement (   index)

通过索引获取指定的元素。

参数
[in]index要检索的元素的索引。有效范围:从0到(count-1)。 count由函数FoxitPDFSDKPython3.PDFArray.GetElementCount 返回。
返回
一个PDFObject 对象,接收指定的元素。 如果有任何错误,此函数将返回null

◆ GetElementCount()

def FoxitPDFSDKPython3.PDFArray.GetElementCount ( )

获取元素的数量。

返回
元素数量。

◆ InsertAt()

def FoxitPDFSDKPython3.PDFArray.InsertAt (   index,
  element 
)

将PDF对象插入到当前PDF数组对象的指定位置。

参数
[in]index参数element将被插入到的位置的索引。 有效范围:从0到(count-1)。 count由函数FoxitPDFSDKPython3.PDFArray.GetElementCount 返回。
如果小于0或当前PDF数组中的元素数量为0, 参数element将被插入到第一个位置。
如果大于当前PDF数组中的元素数量, 参数element将被添加到末尾。
[in]element要插入到当前PDF数组对象的PDF对象。它不应为null
返回
无。

◆ RemoveAt()

def FoxitPDFSDKPython3.PDFArray.RemoveAt (   index)

从当前PDF数组对象中移除指定位置(按索引)的元素。

参数
[in]index将被移除的元素的位置的索引。 有效范围:从0到(count-1)。 count由函数FoxitPDFSDKPython3.PDFArray.GetElementCount 返回。
返回
无。

◆ SetAt()

def FoxitPDFSDKPython3.PDFArray.SetAt (   index,
  element 
)

在当前PDF数组对象的指定位置设置新的PDF对象。

参数
[in]index参数element将被设置到的位置的索引。 有效范围:从0到(count-1)。 count由函数FoxitPDFSDKPython3.PDFArray.GetElementCount 返回。
[in]element要设置到当前PDF数组对象的PDF对象。它不应为null
返回
无。